<?php
/**
 * Copyright (c) 2009, Microsoft
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Microsoft nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY Microsoft ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL Microsoft BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @category   Microsoft
 * @package    WebErrorPHPToolkit
 * @subpackage SiteVariables
 * @version    $Id: SiteVariables.php, v 1.0 2009-10-09 08:00:00Z unknown $
 * @copyright  Copyright (c) 2009, Microsoft (http://www.microsoft.com)
 * @author     a-jetann
 * 
 * Holds variables that used by Custom 404 page, primarily 
 * configuration info.
 */

/**
 * @global mixed $site_variables
 */
$site_variables = array(); /* global scope */


/**
 * Sets global array $site_variables
 *
 * @param array $data
 * @return void
 */
function set_site_variables($data)
{
	foreach($data as $key => $value)
	{
		site_variable_set($key, $value);
	}
}

/**
 * Get global array $site_variables.
 *
 * @return array
 */
function get_site_variables() {
	global $site_variables;

  return $site_variables;
}

/**
 * Get site variable.
 *
 * @param string $name
 * @param mixed $default
 * @return mixed
 */
function site_variable_get($name, $default) {
  global $site_variables;

  return isset($site_variables[$name]) ? $site_variables[$name] : $default;
}

/**
 * Set site variable.
 *
 * @param string $name
 * @param mixed $value
 */
function site_variable_set($name, $value) {
  global $site_variables;
  $name = trim($name);
  $value = trim($value);
  $site_variables[$name] = $value;
}

/**
 * Unset site variable.
 *
 * @param string $name variable name
 * @return void
 */
function site_variable_unset($name) {
  global $site_variables;

  unset($site_variables[$name]);
}


/**
 * Check if site variable has be set.
 * @param string $name variable name
 * @return boolean
 */
function site_variable_isset($name) {
  global $site_variables;

  return isset($site_variables[$name]);
}